Figure.coast/pygmt.grdlandmask/pygmt.select: Migrate the 'area_thresh' parameter to the new Alias System - #4822
Merged
Merged
Conversation
…' parameter to the new Alias System
seisman
added
maintenance
seisman
added
final review call
Contributor
There was a problem hiding this comment.
Pull request overview
Migrates the area_thresh parameter for Figure.coast, pygmt.grdlandmask, and pygmt.select from the legacy @use_alias(A="area_thresh") mechanism to the newer AliasSystem/Alias system, while updating related alias documentation text.
Changes:
- Add explicit
area_threshparameters tocoast,grdlandmask, andselect, and wire them intoAliasSystemas optionA. - Remove
A="area_thresh"from@use_aliaswhere applicable and update the aliases section in docstrings accordingly. - Update the shared
area_threshcommon docstring snippet.
Reviewed changes
Copilot reviewed 4 out of 4 changed files in this pull request and generated 3 comments.
| File | Description |
|---|---|
pygmt/src/select.py |
Adds explicit area_thresh parameter and maps it to GMT option -A via AliasSystem. |
pygmt/src/grdlandmask.py |
Removes @use_alias for A, adds explicit area_thresh, and documents aliases manually. |
pygmt/src/coast.py |
Adds explicit area_thresh parameter and maps it to GMT option -A via AliasSystem. |
pygmt/helpers/decorators.py |
Adjusts the shared COMMON_DOCSTRINGS["area_thresh"] snippet formatting. |
💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.
seisman
removed
the
final review call
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Just regular migration. Plan to make it more Pythonic in a later PR.
Preview: